/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.phoenix.index;

import java.io.IOException;

import org.apache.hadoop.hbase.client.Mutation;
import org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment;

import org.apache.phoenix.hbase.index.covered.IndexCodec;

/**
 *
 */
public abstract class BaseIndexCodec implements IndexCodec {

  @Override
  public void initialize(RegionCoprocessorEnvironment env) throws IOException {
    // noop
  }

  /**
   * {@inheritDoc}
   * <p>
   * By default, the codec is always enabled. Subclasses should override this method if they want do
   * decide to index on a per-mutation basis.
 * @throws IOException 
   */
  @Override
  public boolean isEnabled(Mutation m) throws IOException {
    return true;
  }

  /**
   * {@inheritDoc}
   * <p>
   * Assumes each mutation is not in a batch. Subclasses that have different batching behavior
   * should override this.
   */
  @Override
  public byte[] getBatchId(Mutation m) {
    return null;
  }
}